/*
 * Copyright (c) 2005, romain guy (romain.guy@jext.org) and craig wickesser (craig@codecraig.com)
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 * 
 *     * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <ORGANIZATION> nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package net.java.swingfx.rubberband.canvas;

import javax.swing.JComponent;

import net.java.swingfx.rubberband.rubberbands.RubberBand;

/**
 * An interface for which any {@link javax.swing.JComponent} that wishes to
 * enable rubber band functionality should implement.
 * 
 * The canvas is the area on which the {@link RubberBand} will be drawn onto.
 * 
 * @author rwickesser
 * @since 1.0 $Revision: 1.1 $
 */
public interface RubberBandCanvas {

	/**
	 * Returns the <code>JComponent</code> which is the canvas for the
	 * <code>RubberBand</code>
	 * 
	 * @return the <code>JComponent</code> which is the canvas for the
	 *         <code>RubberBand</code>
	 */
	public JComponent getCanvas();

	/**
	 * Sets the <code>RubberBand</code> for the canvas
	 * 
	 * @param rubberband
	 *            the <code>RubberBand</code> for the canvas
	 */
	public void setRubberBand(RubberBand rubberband);
}